home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / para.lha / para / texnfo-upd.el < prev    next >
Text File  |  1991-04-18  |  66KB  |  1,763 lines
  1. ;;;; texnfo-upd.el
  2.  
  3. ;;; Texinfo mode utilities for updating nodes and menus in Texinfo files.
  4.  
  5. ;;; Version 2.04    17 April 1991
  6. ;;; Robert J. Chassell      
  7. ;;; Please send bug reports to:  bob@ai.mit.edu
  8.  
  9. ;;; Copyright 1989, 1990, 1991 Free Software Foundation
  10.  
  11. ;;; Known bug: update commands fail to ignore @ignore.
  12.  
  13.  
  14. ;;; This file is part of GNU Emacs.
  15.  
  16. ;; GNU Emacs is free software; you can redistribute it and/or modify
  17. ;; it under the terms of the GNU General Public License as published by
  18. ;; the Free Software Foundation; either version 1, or (at your option)
  19. ;; any later version.
  20.  
  21. ;; GNU Emacs is distributed in the hope that it will be useful,
  22. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  23. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24. ;; GNU General Public License for more details.
  25.  
  26. ;; You should have received a copy of the GNU General Public License
  27. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  28. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  29.  
  30.  
  31. ;;; Summary: how to use the updating commands
  32.  
  33. ; The node and menu updating functions automatically
  34.  
  35. ;   * insert missing `@node' lines,
  36. ;   * insert the `Next', `Previous' and `Up' pointers of a node,
  37. ;   * insert or update the menu for a section, 
  38. ;   * create a master menu for a Texinfo source file.
  39. ;
  40. ; Passed an argument, the `texinfo-update-node' and
  41. ; `texinfo-make-menu' functions do their jobs in the region.
  42. ;
  43. ; In brief, the functions for creating or updating nodes and menus, are:
  44. ; 
  45. ;     texinfo-update-node (&optional region-p)            
  46. ;     texinfo-every-node-update ()                        
  47. ;     texinfo-sequential-node-update (&optional region-p)
  48. ; 
  49. ;     texinfo-make-menu (&optional region-p)              
  50. ;     texinfo-all-menus-update ()                         
  51. ;     texinfo-master-menu ()
  52. ;
  53. ;     texinfo-insert-node-lines  (&optional title-p)
  54. ; 
  55. ;     texinfo-indent-menu-description (column &optional region-p)
  56.  
  57. ; The `texinfo-column-for-description' variable specifies the column to
  58. ; which menu descriptions are indented. 
  59.  
  60. ; Texinfo file structure
  61. ; ----------------------
  62.  
  63. ; To use the updating commands, you must structure your Texinfo file
  64. ; hierarchically.  Each `@node' line, with the exception of the top
  65. ; node, must be accompanied by some kind of section line, such as an
  66. ; `@chapter' or `@section' line.  Each node-line/section-line
  67. ; combination must look like this:
  68.  
  69. ;      @node    Lists and Tables, Cross References, Structuring, Top
  70. ;      @comment node-name,        next,             previous,    up
  71. ;      @chapter Making Lists and Tables
  72.  
  73. ; or like this (without the `@comment' line):
  74.  
  75. ;      @node    Lists and Tables, Cross References, Structuring, Top
  76. ;      @chapter Making Lists and Tables
  77.  
  78. ; If the file has a `top' node, it must be called `top' or `Top' and
  79. ; be the first node in the file.
  80.  
  81.  
  82. ;;; The update node functions described in detail
  83.  
  84. ; The `texinfo-update-node' function without an argument inserts
  85. ; the correct next, previous and up pointers for the node in which
  86. ; point is located (i.e., for the node preceding point).
  87.  
  88. ; With an argument, the `texinfo-update-node' function inserts the
  89. ; correct next, previous and up pointers for the nodes inside the
  90. ; region.
  91.  
  92. ; It does not matter whether the  `@node' line has pre-existing
  93. ; `Next', `Previous', or `Up' pointers in it.  They are removed.
  94.  
  95. ; The `texinfo-every-node-update' function runs `texinfo-update-node'
  96. ; on the whole buffer.
  97.  
  98. ; The `texinfo-update-node' function inserts the immediately following
  99. ; and preceding node into the `Next' or `Previous' pointers regardless
  100. ; of their hierarchical level.  This is only useful for certain kinds
  101. ; of text, like a novel, which you go through sequentially.  
  102.  
  103.  
  104. ;;; The menu making functions described in detail
  105.  
  106. ; The `texinfo-make-menu' function without an argument creates or
  107. ; updates a menu for the section encompassing the node that follows
  108. ; point.  With an argument, it makes or updates menus for the nodes
  109. ; within or part of the marked region.
  110.  
  111. ; Whenever an existing menu is updated, the descriptions from
  112. ; that menu are incorporated into the new menu.  This is done by copying
  113. ; descriptions from the existing menu to the entries in the new menu
  114. ; that have the same node names.  If the node names are different, the
  115. ; descriptions are not copied to the new menu.
  116.  
  117. ; Menu entries that refer to other Info files are removed since they
  118. ; are not a node within current buffer.  This is a deficiency.
  119.  
  120. ; The `texinfo-all-menus-update' function runs `texinfo-make-menu'
  121. ; on the whole buffer.
  122.  
  123. ; The `texinfo-master-menu' function creates an extended menu located
  124. ; after the top node.  (The file must have a top node.)  The function
  125. ; first updates all the regular menus in the buffer (incorporating the
  126. ; descriptions from pre-existing menus), and then constructs a master
  127. ; menu that includes every entry from every other menu.  (However, the
  128. ; function cannot update an already existing master menu; if one
  129. ; exists, it must be removed before calling the function.)
  130.  
  131. ; The `texinfo-indent-menu-description' function indents every
  132. ; description in the menu following point, to the specified column.
  133. ; Non-nil argument (prefix, if interactive) means indent every
  134. ; description in every menu in the region.  This function does not
  135. ; indent second and subsequent lines of a multi-line description.
  136.  
  137. ; The `texinfo-insert-node-lines' function inserts `@node' before the
  138. ; `@chapter', `@section', and such like lines of a region in a Texinfo
  139. ; file where the `@node' lines are missing.
  140. ; 
  141. ; With a non-nil argument (prefix, if interactive), the function not
  142. ; only inserts `@node' lines but also inserts the chapter or section
  143. ; titles as the names of the corresponding nodes; and inserts titles
  144. ; as node names in pre-existing `@node' lines that lack names.
  145. ; 
  146. ; Since node names should be more concise than section or chapter
  147. ; titles, node names so inserted will need to be edited manually.
  148.  
  149.  
  150. ;;; The menu making functions
  151.  
  152. (defun texinfo-make-menu (&optional region-p)
  153.   "Without any prefix argument, make or update a menu.
  154. Make the menu for the section enclosing the node found following point.
  155.  
  156. Non-nil argument (prefix, if interactive) means make or update menus
  157. for nodes within or part of the marked region.
  158.  
  159. Whenever a menu exists, and is being updated, the descriptions that
  160. are associated with node names in the pre-existing menu are
  161. incorporated into the new menu.  Otherwise, the nodes' section titles
  162. are inserted as descriptions."
  163.   
  164.   (interactive "P")
  165.   (if (not region-p)
  166.       (let ((level (texinfo-hierarchic-level)))
  167.         (texinfo-make-one-menu level)
  168.         (message "Done...updated the menu.  You may save the buffer."))
  169.     ;; else
  170.     (message "Making or updating menus... ")
  171.     (let ((beginning (region-beginning))
  172.       (region-end (region-end))
  173.           (level (progn         ; find section type following point
  174.                    (goto-char (region-beginning))
  175.                    (texinfo-hierarchic-level))))
  176.       (if (= region-end beginning)
  177.           (error "Please mark a region!"))
  178.       (save-excursion
  179.         (save-restriction
  180.           (widen)
  181.           
  182.           (while  (texinfo-find-lower-level-node level region-end)
  183.             (setq level (texinfo-hierarchic-level)) ; new, lower level
  184.             (texinfo-make-one-menu level))
  185.           
  186.           (while (and (< (point) region-end)
  187.                       (texinfo-find-higher-level-node level region-end))
  188.             (setq level (texinfo-hierarchic-level))
  189.             (while (texinfo-find-lower-level-node level region-end)
  190.               (setq level (texinfo-hierarchic-level)) ; new, lower level
  191.               (texinfo-make-one-menu level))))))
  192.     (message "Done...updated menus.  You may save the buffer.")))
  193.  
  194. (defun texinfo-make-one-menu (level)
  195.   "Make a menu of all the appropriate nodes in this section.
  196. `Appropriate nodes' are those associated with sections that are 
  197. at the level specified by LEVEL.  Point is left at the end of menu."
  198.   (let*
  199.       ((case-fold-search t)
  200.        (beginning
  201.     (save-excursion
  202.       (goto-char (texinfo-update-menu-region-beginning level))
  203.       (end-of-line)
  204.       (point)))
  205.        (end (texinfo-update-menu-region-end level))
  206.        (first (texinfo-menu-first-node beginning end))
  207.        (node-name (progn
  208.                     (goto-char beginning)
  209.                     (texinfo-copy-node-name)))
  210.        (new-menu-list (texinfo-make-menu-list beginning end level)))
  211.     (if (texinfo-old-menu-p beginning first)
  212.         (progn
  213.           (texinfo-incorporate-descriptions new-menu-list)
  214.           (texinfo-delete-old-menu beginning first)))
  215.     (texinfo-insert-menu new-menu-list node-name)))
  216.  
  217. (defun texinfo-all-menus-update (&optional update-all-nodes-p)
  218.   "Update every regular menu in a Texinfo file.
  219. Update pre-existing master menu, if there is one.
  220.  
  221. If called with a non-nil argument, this function first updates all the
  222. nodes in the buffer before updating the menus."
  223.   (interactive "P")
  224.   (let (master-menu-p)
  225.     (save-excursion
  226.       (mark-whole-buffer)
  227.       (message "Checking for a master menu... ")
  228.       (save-excursion
  229.         (if (re-search-forward texinfo-master-menu-header nil t)
  230.             ;; Remove detailed master menu listing
  231.             (progn
  232.               (setq master-menu-p t)
  233.               (goto-char (match-beginning 0))
  234.               (let ((end-of-detailed-menu-descriptions
  235.                      (save-excursion     ; beginning of end menu line
  236.                        (goto-char (texinfo-menu-end))
  237.                        (beginning-of-line) (forward-char -1)
  238.                        (point))))
  239.                 (delete-region (point) end-of-detailed-menu-descriptions)))))
  240.       
  241.       (if update-all-nodes-p
  242.           (progn
  243.             (message "First updating all nodes... ")
  244.             (sleep-for 2)
  245.             (mark-whole-buffer)
  246.             (texinfo-update-node t)))
  247.       
  248.       (message "Updating all menus... ")        
  249.       (sleep-for 2)
  250.       (mark-whole-buffer)
  251.       (texinfo-make-menu t)
  252.       
  253.       (if master-menu-p
  254.           (message "Updating the master menu ... ")
  255.         (sleep-for 2)
  256.         (texinfo-master-menu nil)))
  257.     
  258.     (message "Done...updated all the menus.  You may save the buffer.")))
  259.  
  260. (defun texinfo-find-lower-level-node (level region-end)
  261.   "Search forward from point for node at any level lower than LEVEL.
  262. Search is limited to the end of the marked region, REGION-END, 
  263. and to the end of the menu region for the level.
  264.  
  265. Return t if the node is found, else nil.  Leave point at the beginning
  266. of the node if one is found; else do not move point."
  267.  
  268.   (if (and (< (point) region-end)
  269.            (re-search-forward
  270.             (concat
  271.              "\\(^@node\\).*\n"         ; match node line
  272.              "\\(\\(\\(^@c\\).*\n\\)"   ; match comment line, if any
  273.              "\\|"                      ; or
  274.              "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
  275.              (eval (cdr (assoc level texinfo-update-menu-lower-regexps))))
  276.             ;; the next higher level node marks the end of this
  277.             ;; section, and no lower level node will be found beyond
  278.             ;; this position even if region-end is farther off
  279.             (texinfo-update-menu-region-end level) 
  280.             t))
  281.       (goto-char (match-beginning 1))))
  282.  
  283. (defun texinfo-find-higher-level-node (level region-end)
  284.   "Search forward from point for node at any higher level than argument LEVEL.
  285. Search is limited to the end of the marked region, REGION-END.
  286.  
  287. Return t if the node is found, else nil.  Leave point at the beginning
  288. of the node if one is found; else do not move point."
  289.  
  290.   (if (and (< (point) region-end)
  291.            (re-search-forward
  292.             (concat
  293.              "\\(^@node\\).*\n"         ; match node line
  294.              "\\(\\(\\(^@c\\).*\n\\)"   ; match comment line, if any
  295.              "\\|"                      ; or
  296.              "\\(^@ifinfo[ ]*\n\\)\\)?" ; ifinfo line, if any
  297.              (eval                      ; (won't ever find a `top' node)
  298.               (cdr (assoc level texinfo-update-menu-higher-regexps))))
  299.             nil
  300.             t))
  301.       (goto-char (match-beginning 1))))
  302.  
  303.  
  304. ;;; Making the list of new menu entries
  305.  
  306. (defun texinfo-make-menu-list (beginning end level)
  307.   "Make a list of node names and their descriptions.
  308. Point is left at the end of the menu region, but the menu is not inserted.
  309.  
  310. First argument is position from which to start making menu list; 
  311. second argument is end of region in which to try to locate entries;
  312. third argument is the level of the nodes that are the entries.
  313.  
  314. Node names and descriptions are dotted pairs of strings.  Each pair is
  315. an element of the list.  If the description does not exist, the
  316. element consists only of the node name."
  317.   (goto-char beginning)
  318.   (let (new-menu-list)
  319.     (while (texinfo-menu-locate-entry-p level end)
  320.       (setq new-menu-list 
  321.             (cons (cons 
  322.                    (texinfo-copy-node-name)
  323.                    (texinfo-copy-section-title))
  324.                   new-menu-list)))
  325.     (reverse new-menu-list)))
  326.  
  327. (defun texinfo-menu-locate-entry-p (level search-end)
  328.   "Find a node that will be part of menu for this section.
  329. First argument is a string such as \"section\" specifying the general
  330. hierarchical level of the menu; second argument is a postion
  331. specifying the end of the search.
  332.  
  333. The function returns t if the node is found, else nil.  It searches
  334. forward from point, and leaves point at the beginning of the node.
  335.  
  336. The function finds entries of the same type.  Thus `subsections' and
  337. `unnumberedsubsecs' will appear in the same menu."
  338.   (if (re-search-forward
  339.        (concat
  340.         "\\(^@node\\).*\n"              ; match node line
  341.         "\\(\\(\\(^@c\\).*\n\\)"        ; match comment line, if any
  342.         "\\|"                           ; or
  343.         "\\(^@ifinfo[ ]*\n\\)\\)?"      ; ifinfo line, if any
  344.         (eval
  345.          (cdr (assoc level texinfo-update-menu-same-level-regexps))))
  346.        search-end
  347.        t)
  348.       (goto-char (match-beginning 1))))
  349.  
  350. (defun texinfo-copy-node-name ()
  351.   "Return the node name as a string.
  352.  
  353. Start with point at the beginning of the node line; copy the text
  354. after the node command up to the first comma on the line, if any, and
  355. return the text as a string.  Leaves point at the beginning of the
  356. line.  If there is no node name, returns an empty string."
  357.   
  358.   (save-excursion
  359.     (buffer-substring
  360.      (progn (forward-word 1)              ; skip over node command
  361.             (skip-chars-forward " \t")    ; and over spaces
  362.             (point))
  363.      (if (search-forward
  364.           ","
  365.           (save-excursion (end-of-line) (point)) t) ; bound search
  366.          (1- (point))
  367.        (end-of-line) (point)))))
  368.  
  369. (defun texinfo-copy-section-title ()
  370.   "Return the title of the section as a string.
  371. The title is used as a description line in the menu when one does not
  372. already exist.
  373.  
  374. Move point to the beginning of the appropriate section line by going
  375. to the start of the text matched by last regexp searched for, which
  376. must have been done by `texinfo-menu-locate-entry-p'."
  377.  
  378.   ;; could use the same re-search as in `texinfo-menu-locate-entry-p'
  379.   ;; instead of using `match-beginning'; such a variation would be
  380.   ;; more general, but would waste information already collected
  381.  
  382.   (goto-char (match-beginning 7))       ; match section name 
  383.  
  384.   (buffer-substring
  385.    (progn (forward-word 1)              ; skip over section type
  386.           (skip-chars-forward " \t")    ; and over spaces
  387.           (point))
  388.    (progn (end-of-line) (point))))
  389.  
  390.  
  391. ;;; Handling the old menu
  392.  
  393. (defun texinfo-old-menu-p (beginning first)
  394.   "Move point to the beginning of the menu for this section, if any.
  395. Otherwise move point to the end of the first node of this section.
  396. Return t if a menu is found, nil otherwise.
  397.  
  398. First argument is the position of the beginning of the section in which
  399. the menu will be located; second argument is the position of the first
  400. node within the section.
  401.  
  402. If no menu is found, the function inserts two newlines just before the
  403. end of the section, and leaves point there where a menu ought to be."
  404.   (goto-char beginning)
  405.   (if (not (re-search-forward "^@menu" first 'goto-end))
  406.       (progn (insert "\n\n") (forward-line -2) nil)
  407.     t))
  408.  
  409. (defun texinfo-incorporate-descriptions (new-menu-list)
  410.   "Copy the old menu line descriptions that exist to the new menu.
  411.  
  412. Point must be at beginning of old menu.
  413.  
  414. If the node-name of the new menu entry cannot be found in the old
  415. menu, use the new section title for the description, but if the
  416. node-name of the new menu is found in the old menu, replace the
  417. section title with the old description, whatever it may be.
  418.  
  419. For this function, the new menu is a list made up of lists of dotted
  420. pairs in which the first element of the pair is the node name and the
  421. second element the description. The new menu is changed destructively.
  422. The old menu is the menu as it appears in the texinfo file."
  423.   
  424.   (let ((new-menu-list-pointer new-menu-list)
  425.         (end-of-menu (texinfo-menu-end)))
  426.     (while new-menu-list
  427.       (save-excursion                   ; keep point at beginning of menu 
  428.         (if (search-forward
  429.              (concat "\* "              ; so only menu entries are found
  430.                      (car (car new-menu-list))
  431.                      ":")               ; so only complete entries are found
  432.              end-of-menu
  433.              t) 
  434.             (setcdr (car new-menu-list) 
  435.                     (texinfo-menu-copy-old-description end-of-menu))))
  436.       (setq new-menu-list (cdr new-menu-list))) 
  437.     (setq new-menu-list new-menu-list-pointer)))
  438.  
  439. (defun texinfo-menu-copy-old-description (end-of-menu)
  440.   "Return description field of old menu line as string.
  441. Point must be located just after the node name.  Point left before description.
  442. Single argument, END-OF-MENU, is position limiting search."
  443.   (skip-chars-forward "[:.,\t\n ]+")
  444.   ;; don't copy a carriage return at line beginning with asterisk!
  445.   ;; do copy a description that begins with an `@'!
  446.   (if (and (looking-at "\\(\\w+\\|@\\)")    
  447.            (not (looking-at "\\(^\\* \\|^@end menu\\)")))  
  448.       (buffer-substring
  449.        (point)
  450.        (save-excursion
  451.          (re-search-forward "\\(^\\* \\|^@end menu\\)" end-of-menu t)
  452.          (forward-line -1)
  453.          (end-of-line)                  ; go to end of last description line
  454.          (point)))
  455.     ""))
  456.  
  457. (defun texinfo-menu-end ()
  458.   "Return position of end of menu. Does not change location of point.
  459. Signal an error if not end of menu."
  460.   (save-excursion
  461.     (if (re-search-forward "^@end menu" nil t)
  462.         (point)
  463.       (error "Menu does not have an end."))))
  464.  
  465. (defun texinfo-delete-old-menu (beginning first)
  466.   "Delete the old menu.  Point must be in or after menu.
  467. First argument is position of the beginning of the section in which
  468. the menu will be located; second argument is the position of the first
  469. node within the section."
  470.   ;; No third arg to search, so error if search fails.
  471.   (re-search-backward "^@menu" beginning)
  472.   (delete-region (point)
  473.                  (save-excursion
  474.                    (re-search-forward "^@end menu" first)
  475.                    (point))))
  476.  
  477.  
  478. ;;; Inserting new menu
  479.  
  480. ;; try 32, but perhaps 24 is better
  481. (defvar texinfo-column-for-description 32
  482.   "*Column at which descriptions start in a Texinfo menu.")
  483.  
  484. (defun texinfo-insert-menu (menu-list node-name)
  485.   "Insert formatted menu at point.
  486. Indents the first line of the description, if any, to the value of
  487. texinfo-column-for-description.
  488.  
  489. MENU-LIST has form:
  490.  
  491.     \(\(\"node-name1\" . \"description\"\) 
  492.     \(\"node-name\" . \"description\"\) ... \)
  493.  
  494. However, there does not need to be a description field."
  495.   
  496.   (insert "@menu\n")
  497.   (while menu-list
  498.     (if (cdr (car menu-list))       ; menu-list has description entry
  499.         (progn
  500.           (insert 
  501.            (format "* %s::" (car (car menu-list)))) ; node-name entry
  502.           (indent-to texinfo-column-for-description 2)
  503.           (insert 
  504.            (format "%s\n" (cdr (car menu-list)))))  ; description entry
  505.         ;; else menu-list lacks description entry
  506.       (insert
  507.        (format "* %s::\n" (car (car menu-list)))))  ; node-name entry
  508.     (setq menu-list (cdr menu-list)))
  509.   (insert "@end menu")
  510.   (message
  511.    "Updated \"%s\" level menu following node: %s ... "
  512.    level node-name))
  513.  
  514.  
  515. ;;; Handling description indentation
  516.  
  517. ; Since the make-menu functions indent descriptions, these functions
  518. ; are useful primarily for indenting a single menu specially.
  519.  
  520. (defun texinfo-indent-menu-description (column &optional region-p)
  521.   "Indent every description in menu following point to COLUMN.  
  522. Non-nil argument (prefix, if interactive) means indent every
  523. description in every menu in the region.  Does not indent second and
  524. subsequent lines of a multi-line description."
  525.   
  526.   (interactive
  527.    "nIndent menu descriptions to (column number): \nP")
  528.   (save-excursion
  529.     (save-restriction
  530.       (widen)
  531.       (if (not region-p)
  532.           (progn
  533.             (re-search-forward "^@menu")
  534.             (texinfo-menu-indent-description column)
  535.             (message
  536.              "Indented descriptions in menu.  You may save the buffer."))
  537.         ;;else
  538.         (message "Indenting every menu description in region... ")
  539.         (goto-char (region-beginning))
  540.         (while (and (< (point) (region-end))
  541.                     (texinfo-locate-menu-p))
  542.           (forward-line 1)
  543.           (texinfo-menu-indent-description column))
  544.         (message "Indenting done.  You may save the buffer.")))))
  545.  
  546. (defun texinfo-menu-indent-description (to-column-number)
  547.   "Indent the Texinfo file menu description to TO-COLUMN-NUMBER.
  548. Start with point just after the word `menu' in the `@menu' line and
  549. leave point on the line before the `@end menu' line.  Does not indent
  550. second and subsequent lines of a multi-line description."
  551.   (let* ((beginning-of-next-line (point)))
  552.     (while (< beginning-of-next-line
  553.               (save-excursion     ; beginning of end menu line
  554.                 (goto-char (texinfo-menu-end))
  555.                 (beginning-of-line)
  556.                 (point)))
  557.       (if (search-forward "::" (texinfo-menu-end) t)
  558.           (progn
  559.             (let ((beginning-white-space (point)))
  560.               (skip-chars-forward " \t")  ; skip over spaces
  561.               (if (looking-at "\\(@\\|\\w\\)+") ; if there is text
  562.                   (progn
  563.                     ;; remove pre-existing indentation
  564.                     (delete-region beginning-white-space (point))
  565.                     (indent-to-column to-column-number))))))
  566.       ;; position point at beginning of next line
  567.       (forward-line 1)                  
  568.       (setq beginning-of-next-line (point)))))
  569.  
  570.  
  571. ;;; Making the master menu
  572.  
  573. (defun texinfo-master-menu (update-all-nodes-menus-p)
  574.   "Make a master menu for a whole Texinfo file.
  575. Non-nil argument (prefix, if interactive) means first update all
  576. existing nodes and menus.  Remove pre-existing master menu, if there is one.
  577.  
  578. This function creates a master menu that follows the top node.  The
  579. master menu includes every entry from all the other menus.  It
  580. replaces any existing ordinary menu that follows the top node.
  581.  
  582. If called with a non-nil argument, this function first updates all the
  583. menus in the buffer (incorporating descriptions from pre-existing
  584. menus) before it constructs the master menu.
  585.  
  586. The function removes the detailed part of an already existing master
  587. menu.  This action depends on the pre-exisitng master menu using the
  588. standard `texinfo-master-menu-header'.
  589.  
  590. The master menu has the following format, which is adapted from the
  591. recommendation in the Texinfo Manual:
  592.  
  593.    * The first part contains the major nodes in the Texinfo file: the
  594.      nodes for the chapters, chapter-like sections, and the major
  595.      appendices.  This includes the indices, so long as they are in
  596.      chapter-like sections, such as unnumbered sections.
  597.  
  598.    * The second and subsequent parts contain a listing of the other,
  599.      lower level menus, in order.  This way, an inquirer can go
  600.      directly to a particular node if he or she is searching for
  601.      specific information.
  602.  
  603. Each of the menus in the detailed node listing is introduced by the
  604. title of the section containing the menu."
  605.  
  606.   (interactive "P")
  607.   (widen)
  608.   (goto-char (point-min))
  609.  
  610.   ;; Move point to location after `top'.
  611.   (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t))
  612.       (error "This buffer needs a Top node!"))
  613.  
  614.   (let ((first-chapter                  
  615.          (save-excursion (re-search-forward "^@node") (point))))
  616.     (if (re-search-forward texinfo-master-menu-header first-chapter t)
  617.         ;; Remove detailed master menu listing
  618.         (progn
  619.            (goto-char (match-beginning 0))
  620.           (let ((end-of-detailed-menu-descriptions
  621.                  (save-excursion     ; beginning of end menu line
  622.                    (goto-char (texinfo-menu-end))
  623.                    (beginning-of-line) (forward-char -1)
  624.                    (point))))
  625.             (delete-region (point) end-of-detailed-menu-descriptions)))))
  626.  
  627.   (if update-all-nodes-menus-p
  628.       (progn
  629.         (message "Making a master menu...first updating all nodes... ")
  630.         (sleep-for 2)
  631.         (mark-whole-buffer)
  632.         (texinfo-update-node t)
  633.  
  634.         (message "Updating all menus... ")        
  635.         (sleep-for 2)
  636.         (mark-whole-buffer)
  637.         (texinfo-make-menu t)))
  638.  
  639.   (message "Now making the master menu... ")
  640.   (sleep-for 2)
  641.   (goto-char (point-min))
  642.   (texinfo-insert-master-menu-list
  643.    (texinfo-master-menu-list))
  644.  
  645.   ;; Remove extra newlines that texinfo-insert-master-menu-list
  646.   ;; may have inserted.
  647.  
  648.   (save-excursion
  649.     (goto-char (point-min))
  650.     
  651.     (re-search-forward texinfo-master-menu-header)
  652.     (goto-char (match-beginning 0))
  653.     (insert "\n")
  654.     (delete-blank-lines)
  655.     
  656.     (re-search-backward "^@menu")
  657.     (forward-line -1)
  658.     (delete-blank-lines)
  659.     
  660.     (re-search-forward "^@end menu")
  661.     (forward-line 1)
  662.     (delete-blank-lines))
  663.  
  664.   (message "Done...completed making master menu.  You may save the buffer."))
  665.  
  666. (defun texinfo-master-menu-list ()
  667.   "Return a list of menu entries and header lines for the master menu.
  668.  
  669. Start with the menu for chapters and indices and then find each
  670. following menu and the title of the node preceding that menu.
  671.  
  672. The master menu list has this form:
  673.  
  674.     \(\(\(... \"entry-1-2\"  \"entry-1\"\) \"title-1\"\)
  675.       \(\(... \"entry-2-2\"  \"entry-2-1\"\) \"title-2\"\)
  676.       ...\)
  677.  
  678. However, there does not need to be a title field."
  679.  
  680.   (let (master-menu-list)
  681.     (while (texinfo-locate-menu-p)
  682.       (setq master-menu-list 
  683.             (cons (list
  684.                    (texinfo-copy-menu)
  685.                    (texinfo-copy-menu-title))
  686.                   master-menu-list)))
  687.     (reverse master-menu-list)))
  688.  
  689. (defun texinfo-insert-master-menu-list (master-menu-list)
  690.   "Format and insert the master menu in the current buffer."
  691.   (goto-char (point-min))
  692.   (re-search-forward "^@menu")
  693.   (beginning-of-line)
  694.   (delete-region (point)        ; buffer must have ordinary top menu
  695.                  (save-excursion
  696.                    (re-search-forward "^@end menu")
  697.                    (point)))
  698.  
  699.   (save-excursion                       ; leave point at beginning of menu
  700.   ;; Handle top of menu
  701.   (insert "\n@menu\n")
  702.   ;; Insert chapter menu entries
  703.   (setq this-very-menu-list (reverse (car (car master-menu-list))))
  704.   ;;; Tell user what is going on.
  705.   (message "Inserting chapter menu entry: %s ... " this-very-menu-list)
  706.   (while this-very-menu-list
  707.     (insert "* " (car this-very-menu-list) "\n")
  708.     (setq this-very-menu-list (cdr this-very-menu-list)))
  709.   
  710.   (setq master-menu-list (cdr master-menu-list))
  711.  
  712.   (insert texinfo-master-menu-header)
  713.   
  714.   ;; Now, insert all the other menus
  715.  
  716.   ;; The menu master-menu-list has a form like this:
  717.   ;; ((("beta"  "alpha") "title-A")
  718.   ;;  (("delta" "gamma") "title-B"))
  719.  
  720.   (while master-menu-list
  721.  
  722.     (message
  723.      "Inserting menu for %s .... " (car (cdr (car master-menu-list))))
  724.     ;; insert title of menu section
  725.     (insert "\n" (car (cdr (car master-menu-list))) "\n\n")
  726.  
  727.     ;; insert each menu entry
  728.     (setq this-very-menu-list (reverse (car (car master-menu-list))))
  729.     (while this-very-menu-list
  730.       (insert "* " (car this-very-menu-list) "\n")
  731.       (setq this-very-menu-list (cdr this-very-menu-list)))
  732.     
  733.     (setq master-menu-list (cdr master-menu-list)))
  734.   
  735.   ;; Finish menu
  736.   (insert "@end menu\n\n")))
  737.  
  738. (defvar texinfo-master-menu-header
  739.   "\n --- The Detailed Node Listing ---\n"
  740.   "String inserted before lower level entries in Texinfo master menu.
  741. It comes after the chapter-level menu entries.")
  742.  
  743. (defun texinfo-locate-menu-p ()
  744.   "Find the next menu in the texinfo file.
  745. If found, leave point after word `menu' on the `@menu' line, and return t.
  746. If a menu is not found, do not move point and return nil."
  747.   (re-search-forward "\\(^@menu\\)" nil t))
  748.  
  749. (defun texinfo-copy-menu-title  ()
  750.   "Return the title of the section preceding the menu as a string.
  751. If such a title cannot be found, return an empty string.  Do not move
  752. point."
  753.   (save-excursion
  754.     (if (re-search-backward
  755.          (concat
  756.           "\\(^@node\\).*\n"            ; match node line
  757.           "\\(\\(\\(^@c\\).*\n\\)"      ; match comment line, if any
  758.           "\\|"                         ; or
  759.           "\\(^@ifinfo[ ]*\n\\)\\)?"    ; ifinfo line, if any
  760.           (eval
  761.            (cdr
  762.             (assoc (texinfo-hierarchic-level)
  763.                    texinfo-update-menu-higher-regexps))))
  764.          nil
  765.          t)
  766.         (texinfo-copy-section-title)
  767.       " ")))
  768.  
  769. (defun texinfo-copy-menu ()
  770.   "Return the entries of an existing menu as a list.
  771. Start with point just after the word `menu' in the `@menu' line
  772. and leave point on the line before the `@end menu' line."
  773.   (let* (this-menu-list
  774.          (end-of-menu (texinfo-menu-end)) ; position of end of `@end menu'
  775.          (last-entry (save-excursion      ; position of beginning of
  776.                                           ; last `* ' entry
  777.                       (goto-char end-of-menu)
  778.                       (re-search-backward "^\* ") ; handle multi-line desc.
  779.                       (point))))
  780.     (while (< (point) last-entry)
  781.       (if (re-search-forward  "^\* " end-of-menu t)
  782.           (progn
  783.             (setq this-menu-list
  784.                   (cons
  785.                    (buffer-substring 
  786.                     (point)
  787.                     ;; copy multi-line descriptions
  788.                     (save-excursion
  789.                       (re-search-forward "\\(^\* \\|^@e\\)" nil t)
  790.                       (- (point) 3)))
  791.                    this-menu-list)))))
  792.     this-menu-list))
  793.  
  794.  
  795. ;;; Determining the hierarchical level in the texinfo file
  796.  
  797. (defun texinfo-specific-section-type () 
  798.   "Return the specific type of next section, as a string.
  799. For example, \"unnumberedsubsec\".  Return \"top\" for top node.
  800.  
  801. Searches forward for a section.  Hence, point must be before the
  802. section whose type will be found.  Does not move point.  Signal an
  803. error if the node is not the top node and a section is not found."
  804.   (save-excursion
  805.     (cond
  806.      ((re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)"
  807. ;;; Following search limit by cph but causes a bug
  808. ;;;             (save-excursion
  809. ;;;               (end-of-line)
  810. ;;;               (point))
  811.                          nil
  812.              t)
  813.       "top")
  814.      ((re-search-forward texinfo-section-types-regexp nil t)
  815.       (buffer-substring (progn (beginning-of-line) ; copy its name
  816.                                (1+ (point)))
  817.                         (progn (forward-word 1)
  818.                                (point))))
  819.      (t
  820.       (error
  821.        "texinfo-specific-section-type: Chapter or section not found.")))))
  822.  
  823. (defun texinfo-hierarchic-level ()
  824.   "Return the general hierarchal level of the next node in a texinfo file.
  825. Thus, a subheading or appendixsubsec is of type subsection."
  826.   (cdr (assoc
  827.         (texinfo-specific-section-type)
  828.         texinfo-section-to-generic-alist)))
  829.  
  830.  
  831. ;;; Locating the major positions
  832.  
  833. (defun texinfo-update-menu-region-beginning (level)  
  834.   "Locate beginning of higher level section this section is within.
  835. Return position of the beginning of the node line; do not move point.
  836. Thus, if this level is subsection, searches backwards for section node.
  837. Only argument is a string of the general type of section."
  838.   
  839.   (cond
  840.    ((or (string-equal "top" level)
  841.     (string-equal "chapter" level))
  842.     (save-excursion
  843.       (goto-char (point-min))
  844.       (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)
  845.       (beginning-of-line)
  846.       (point)))
  847.    (t
  848.     (save-excursion
  849.       (re-search-backward
  850.        (concat
  851.         "\\(^@node\\).*\n"              ; match node line
  852.         "\\(\\(\\(^@c\\).*\n\\)"        ; match comment line, if any
  853.         "\\|"                           ; or
  854.         "\\(^@ifinfo[ ]*\n\\)\\)?"      ; ifinfo line, if any
  855.         (eval
  856.          (cdr (assoc level texinfo-update-menu-higher-regexps))))
  857.        nil
  858.        'goto-beginning)
  859.       (point)))))
  860.  
  861. (defun texinfo-update-menu-region-end (level)  
  862.   "Locate end of higher level section this section is within.
  863. Return position; do not move point.  Thus, if this level is a
  864. subsection, find the node for the section this subsection is within.
  865. If level is top or chapter, returns end of file.  Only argument is a
  866. string of the general type of section."
  867.  
  868.   (save-excursion
  869.     (if (re-search-forward
  870.          (concat
  871.           "\\(^@node\\).*\n"            ; match node line
  872.           "\\(\\(\\(^@c\\).*\n\\)"      ; match comment line, if any
  873.           "\\|"                         ; or
  874.           "\\(^@ifinfo[ ]*\n\\)\\)?"    ; ifinfo line, if any
  875.           (eval
  876.            (cdr (assoc level texinfo-update-menu-higher-regexps))))
  877.          nil
  878.          'goto-end)
  879.         (match-beginning 1)
  880.       (point-max))))
  881.  
  882. (defun texinfo-menu-first-node (beginning end)
  883.   "Locate first node of the section the menu will be placed in.  
  884. Return position; do not move point.
  885. The menu will be located just before this position.  
  886.  
  887. First argument is the position of the beginning of the section in
  888. which the menu will be located; second argument is the position of the
  889. end of that region; it limits the search."
  890.   
  891.   (save-excursion
  892.     (goto-char beginning)
  893.     (forward-line 1)
  894.     (re-search-forward "^@node" end t)
  895.     (beginning-of-line)
  896.     (point)))
  897.  
  898.  
  899. ;;; Alists and regular expressions for defining hierarchical levels
  900.  
  901. (defvar texinfo-section-to-generic-alist
  902.   '(("top" . "top")
  903.  
  904.     ("chapter" . "chapter")
  905.     ("unnumbered" . "chapter")
  906.     ("majorheading" . "chapter")
  907.     ("chapheading" . "chapter")
  908.     ("appendix" . "chapter")
  909.     
  910.     ("section" . "section")
  911.     ("unnumberedsec" . "section")
  912.     ("heading" . "section")
  913.     ("appendixsec" . "section")
  914.     
  915.     ("subsection" . "subsection")
  916.     ("unnumberedsubsec" . "subsection")
  917.     ("subheading" . "subsection")
  918.     ("appendixsubsec" . "subsection")
  919.     
  920.     ("subsubsection" . "subsubsection")
  921.     ("unnumberedsubsubsec" . "subsubsection")
  922.     ("subsubheading" . "subsubsection")
  923.     ("appendixsubsubsec" . "subsubsection"))
  924.   "*An alist of specific and corresponding generic Texinfo section types.
  925. The keys are strings specifying specific types of section; the values
  926. are strings of their corresponding general types.")
  927.  
  928. (defvar texinfo-section-types-regexp
  929.   "^@\\(chapter \\|sect\\|sub\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)"
  930.   "Regexp matching chapter, section, other headings (but not the top node).")
  931.  
  932. (defvar texinfo-chapter-level-regexp 
  933.   "chapter\\|unnumbered \\|appendix \\|majorheading\\|chapheading"
  934.   "Regular expression matching just the Texinfo chapter level headings.")
  935.  
  936. (defvar texinfo-section-level-regexp 
  937.   "section\\|unnumberedsec\\|heading \\|appendixsec"
  938.   "Regular expression matching just the Texinfo section level headings.")
  939.  
  940. (defvar texinfo-subsection-level-regexp 
  941.   "subsection\\|unnumberedsubsec\\|subheading\\|appendixsubsec"
  942.   "Regular expression matching just the Texinfo subsection level headings.")
  943.  
  944. (defvar texinfo-subsubsection-level-regexp
  945.   "subsubsection\\|unnumberedsubsubsec\\|subsubheading\\|appendixsubsubsec"
  946.   "Regular expression matching just the Texinfo subsubsection level headings.")
  947.  
  948. (defvar texinfo-update-menu-same-level-regexps
  949.   '(("top" . "top[ \t]+")
  950.     ("chapter" . 
  951.      (concat "\\(^@\\)\\(" texinfo-chapter-level-regexp "\\)[ \t]*"))
  952.     ("section" . 
  953.      (concat "\\(^@\\)\\(" texinfo-section-level-regexp "\\)[ \t]*"))
  954.     ("subsection" .  
  955.      (concat "\\(^@\\)\\(" texinfo-subsection-level-regexp "\\)[ \t]+"))
  956.     ("subsubsection" . 
  957.      (concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp "\\)[ \t]+")))
  958.   "*Regexps for searching for same level sections in a Texinfo file.
  959. The keys are strings specifying the general hierarchical level in the
  960. document; the values are regular expressions.")
  961.  
  962. (defvar texinfo-update-menu-higher-regexps
  963.   '(("top" . "^@node [ \t]*DIR") 
  964.     ("chapter" . "^@node [ \t]*top[ \t]*\\(,\\|$\\)")
  965.     ("section" .
  966.      (concat 
  967.       "\\(^@\\("
  968.       texinfo-chapter-level-regexp
  969.       "\\)[ \t]*\\)"))
  970.     ("subsection" .
  971.      (concat 
  972.       "\\(^@\\("
  973.       texinfo-section-level-regexp
  974.       "\\|"
  975.       texinfo-chapter-level-regexp
  976.       "\\)[ \t]*\\)"))
  977.     ("subsubsection" .
  978.      (concat 
  979.       "\\(^@\\("
  980.       texinfo-subsection-level-regexp
  981.       "\\|"
  982.       texinfo-section-level-regexp
  983.       "\\|"
  984.       texinfo-chapter-level-regexp
  985.       "\\)[ \t]*\\)")))
  986.   "*Regexps for searching for higher level sections in a Texinfo file.
  987. The keys are strings specifying the general hierarchical level in the
  988. document; the values are regular expressions.")
  989.  
  990. (defvar texinfo-update-menu-lower-regexps
  991.   '(("top" . 
  992.      (concat 
  993.       "\\(^@\\("
  994.       texinfo-chapter-level-regexp
  995.       "\\|"
  996.       texinfo-section-level-regexp
  997.       "\\|"
  998.       texinfo-subsection-level-regexp
  999.       "\\|"
  1000.       texinfo-subsubsection-level-regexp
  1001.       "\\)[ \t]*\\)"))
  1002.     ("chapter" . 
  1003.      (concat 
  1004.       "\\(^@\\("
  1005.       texinfo-section-level-regexp
  1006.       "\\|"
  1007.       texinfo-subsection-level-regexp
  1008.       "\\|"
  1009.       texinfo-subsubsection-level-regexp
  1010.       "\\)[ \t]*\\)"))
  1011.     ("section" .
  1012.      (concat 
  1013.       "\\(^@\\("
  1014.       texinfo-subsection-level-regexp
  1015.       "\\|"
  1016.       texinfo-subsubsection-level-regexp
  1017.       "\\)[ \t]+\\)"))
  1018.     ("subsection" .
  1019.      (concat 
  1020.       "\\(^@\\("
  1021.       texinfo-subsubsection-level-regexp
  1022.       "\\)[ \t]+\\)"))
  1023.     ("subsubsection" . "nothing lower"))
  1024.   "*Regexps for searching for lower level sections in a Texinfo file.
  1025. The keys are strings specifying the general hierarchical level in the
  1026. document; the values are regular expressions.")
  1027.  
  1028.  
  1029. ;;; Updating a node
  1030.  
  1031. (defun texinfo-update-node (&optional region-p)
  1032.   "Without any prefix argument, update the node in which point is located.
  1033. Non-nil argument (prefix, if interactive) means update the nodes in the
  1034. marked region.
  1035.  
  1036. The functions for creating or updating nodes and menus, and their
  1037. keybindings, are:
  1038.  
  1039.     texinfo-update-node (&optional region-p)    \\[texinfo-update-node]
  1040.     texinfo-every-node-update ()                \\[texinfo-every-node-update]
  1041.     texinfo-sequential-node-update (&optional region-p)
  1042.  
  1043.     texinfo-make-menu (&optional region-p)      \\[texinfo-make-menu]
  1044.     texinfo-all-menus-update ()                 \\[texinfo-all-menus-update]
  1045.     texinfo-master-menu ()
  1046.  
  1047.     texinfo-indent-menu-description (column &optional region-p)
  1048.  
  1049. The `texinfo-column-for-description' variable specifies the column to
  1050. which menu descriptions are indented. Its default value is 32."
  1051.   
  1052.   (interactive "P")
  1053.   (if (not region-p)
  1054.       (let ((auto-fill-hook nil)) ; update a single node
  1055.         (if (not (re-search-backward "^@node" (point-min) t))
  1056.             (error "Node line not found before this position."))
  1057.         (texinfo-update-the-node)
  1058.         (message "Done...updated the node.  You may save the buffer."))
  1059.     ;; else
  1060.     (let ((auto-fill-hook nil)
  1061.           (beginning (region-beginning))
  1062.       (end (region-end)))
  1063.       (if (= end beginning)
  1064.           (error "Please mark a region!"))
  1065.       (save-restriction
  1066.     (narrow-to-region beginning end)
  1067.     (goto-char beginning)
  1068.         (push-mark)
  1069.     (while (re-search-forward "^@node" (point-max) t)
  1070.           (beginning-of-line)            
  1071.           (texinfo-update-the-node))
  1072.         (message "Done...updated nodes in region.  You may save the buffer.")))))
  1073.  
  1074. (defun texinfo-every-node-update ()
  1075.   "Update every node in a Texinfo file."
  1076.   (interactive)
  1077.   (save-excursion
  1078.     (mark-whole-buffer)
  1079.     (texinfo-update-node t)
  1080.     (message "Done...updated every node.       You may save the buffer.")))
  1081.  
  1082. (defun texinfo-update-the-node ()
  1083.   "Update one node.  Point must be at the beginning of node line.  
  1084. Leave point at the end of the node line."
  1085.   (texinfo-check-for-node-name)
  1086.   (texinfo-delete-existing-pointers)
  1087.   (message "Updating node: %s ... " (texinfo-copy-node-name))
  1088.   (save-restriction
  1089.     (widen)
  1090.     (let*
  1091.         ((case-fold-search t)
  1092.          (level (texinfo-hierarchic-level))
  1093.          (beginning (texinfo-update-menu-region-beginning level))
  1094.          (end (texinfo-update-menu-region-end level)))
  1095.       (if (string-equal level "top")
  1096.           (texinfo-top-pointer-case)
  1097.         ;; else
  1098.         (texinfo-insert-pointer beginning end level 'next)
  1099.         (texinfo-insert-pointer beginning end level 'previous)
  1100.         (texinfo-insert-pointer beginning end level 'up)
  1101.         (texinfo-clean-up-node-line)))))
  1102.  
  1103. (defun texinfo-top-pointer-case ()
  1104.   "Insert pointers in the Top node.  This is a special case.
  1105.  
  1106. The `Next' pointer is a pointer to a chapter or section at a lower
  1107. hierarchical level in the file.  The `Previous' and `Up' pointers are
  1108. to `(dir)'.  Point must be at the beginning of the node line, and is
  1109. left at the end of the node line."
  1110.  
  1111.   (texinfo-clean-up-node-line)
  1112.   (insert ", " 
  1113.           (save-excursion
  1114.             ;; There may be an @chapter or other such command between
  1115.             ;; the top node line and the next node line, as a title
  1116.             ;; for an `ifinfo' section. This @chapter command must
  1117.             ;; must be skipped.  So the procedure is to search for
  1118.             ;; the next `@node' line, and then copy its name.
  1119.             (if (re-search-forward "^@node" nil t)
  1120.                 (progn
  1121.                   (beginning-of-line)
  1122.                   (texinfo-copy-node-name))
  1123.               " "))
  1124.           ", (dir), (dir)"))
  1125.  
  1126. (defun texinfo-check-for-node-name ()
  1127.   "Determine whether the node has a node name.  Prompt for one if not.
  1128. Point must be at beginning of node line.  Does not move point."
  1129.   (save-excursion
  1130.     (forward-word 1)                    ; skip over node command
  1131.     (skip-chars-forward " \t")          ; and over spaces
  1132.     (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what info looks for
  1133.                                         ; alternatively, use "[a-zA-Z]+"
  1134.         (let ((node-name (read-from-minibuffer "Node name: ")))
  1135.           (insert " " node-name)))))
  1136.  
  1137. (defun texinfo-delete-existing-pointers ()
  1138.   "Delete `Next', `Previous', and `Up' pointers.  
  1139. Starts from the current position of the cursor, and searches forward
  1140. on the line for a comma and if one is found, deletes the rest of the
  1141. line, including the comma.  Leaves point at beginning of line."
  1142.   (if (search-forward "," (save-excursion (end-of-line) (point)) t)
  1143.       (progn
  1144.         (goto-char (1- (point)))
  1145.         (kill-line nil)))
  1146.   (beginning-of-line))
  1147.  
  1148. (defun texinfo-find-pointer (beginning end level direction)
  1149.   "Move point to section associated with next, previous, or up pointer.
  1150. Return type of pointer (either 'normal or 'no-pointer).
  1151.  
  1152. The first and second arguments bound the search for a pointer to the
  1153. beginning and end, respectively, of the enclosing higher level
  1154. section.  The third argument is a string specifying the general kind
  1155. of section such as \"chapter\ or \"section\".  When looking for the
  1156. `Next' pointer, the section found will be at the same hierarchical
  1157. level in the Texinfo file; when looking for the `Previous' pointer,
  1158. the section found will be at the same or higher hierarchical level in
  1159. the Texinfo file; when looking for the `Up' pointer, the section found
  1160. will be at some level higher in the Texinfo file.  The fourth argument
  1161. \(one of 'next, 'previous, or 'up\) specifies whether to find the
  1162. `Next', `Previous', or `Up' pointer."
  1163.  
  1164.   (cond ((eq direction 'next)
  1165.          (forward-line 3)             ; skip over current node
  1166.          (if (re-search-forward
  1167.               (eval
  1168.                (cdr (assoc level texinfo-update-menu-same-level-regexps)))
  1169.               end
  1170.               t)
  1171.              'normal
  1172.            'no-pointer))
  1173.         ((eq direction 'previous)
  1174.          (if (re-search-backward
  1175.               (concat
  1176.                "\\("
  1177.                (eval
  1178.                 (cdr (assoc level texinfo-update-menu-same-level-regexps)))
  1179.                "\\|"
  1180.                (eval
  1181.                 (cdr (assoc level texinfo-update-menu-higher-regexps)))
  1182.                "\\)")
  1183.               beginning
  1184.               t)
  1185.              'normal
  1186.            'no-pointer))
  1187.         ((eq direction 'up)
  1188.          (if (re-search-backward
  1189.              (eval (cdr (assoc level texinfo-update-menu-higher-regexps)))
  1190.               (save-excursion
  1191.                 (goto-char beginning)
  1192.                 (beginning-of-line)
  1193.                 (point))
  1194.               t)
  1195.              'normal
  1196.            'no-pointer))
  1197.         (t
  1198.          (error "texinfo-find-pointer: lack proper arguments"))))
  1199.  
  1200. (defun texinfo-pointer-name (kind)
  1201.   "Return the node name preceding the section command.
  1202. The argument is the kind of section, either normal or no-pointer."
  1203.   (let (name)
  1204.     (cond ((eq kind 'normal)
  1205.            (end-of-line)                ; this handles prev node top case
  1206.            (re-search-backward          ; when point is already 
  1207.             "^@node"                    ; at the beginning of @node line
  1208.             (save-excursion (forward-line -3))
  1209.             t)
  1210.            (setq name (texinfo-copy-node-name)))
  1211.       ((eq kind 'no-pointer)
  1212.        (setq name " ")))    ; put a blank in the pointer slot
  1213.     name))
  1214.  
  1215. (defun texinfo-insert-pointer (beginning end level direction)
  1216.   "Insert the `Next', `Previous' or `Up' node name at point.
  1217. Move point forward.  
  1218.  
  1219. The first and second arguments bound the search for a pointer to the
  1220. beginning and end, respectively, of the enclosing higher level
  1221. section.  The third argument is the hierarchical level of the Texinfo
  1222. file, a string such as \"section\".  The fourth argument is direction
  1223. towards which the pointer is directed, one of `next, `previous, or
  1224. 'up."
  1225.  
  1226.   (end-of-line)
  1227.   (insert
  1228.    ", "
  1229.    (save-excursion
  1230.      (texinfo-pointer-name
  1231.       (texinfo-find-pointer beginning end level direction)))))
  1232.  
  1233. (defun texinfo-clean-up-node-line ()
  1234.   "Remove extra commas, if any, at end of node line."
  1235.   (end-of-line)
  1236.   (skip-chars-backward ", ")
  1237.   (delete-region (point) (save-excursion (end-of-line) (point))))
  1238.  
  1239.  
  1240. ;;; Updating nodes sequentially
  1241. ; These sequential update functions insert `Next' or `Previous'
  1242. ; pointers that point to the following or preceding nodes even if they
  1243. ; are at higher or lower hierarchical levels.  This means that if a
  1244. ; section contains one or more subsections, the section's `Next'
  1245. ; pointer will point to the subsection and not the following section.
  1246. ; (The subsection to which `Next' points will most likely be the first
  1247. ; item on the section's menu.)
  1248.  
  1249. (defun texinfo-sequential-node-update (&optional region-p)
  1250.   "Update one node (or many) in a Texinfo file with sequential pointers.
  1251.  
  1252. This function causes the `Next' or `Previous' pointer to point to the
  1253. immediately preceding or following node, even if it is at a higher or
  1254. lower hierarchical level in the document.  Continually pressing `n' or
  1255. `p' takes you straight through the file.
  1256.  
  1257. Without any prefix argument, update the node in which point is located.
  1258. Non-nil argument (prefix, if interactive) means update the nodes in the
  1259. marked region.
  1260.  
  1261. This command makes it awkward to navigate among sections and
  1262. subsections; it should be used only for those documents that are meant
  1263. to be read like a novel rather than a reference, and for which the
  1264. Info `g*' command is inadequate."
  1265.   
  1266.   (interactive "P")
  1267.   (if (not region-p)
  1268.       (let ((auto-fill-hook nil))   ; update a single node
  1269.         (if (not (re-search-backward "^@node" (point-min) t))
  1270.             (error "Node line not found before this position."))
  1271.         (texinfo-sequentially-update-the-node)
  1272.         (message 
  1273.          "Done...sequentially updated the node .  You may save the buffer."))
  1274.     ;; else
  1275.     (let ((auto-fill-hook nil)
  1276.           (beginning (region-beginning))
  1277.           (end (region-end)))
  1278.       (if (= end beginning)
  1279.           (error "Please mark a region!"))
  1280.       (save-restriction
  1281.         (narrow-to-region beginning end)
  1282.         (goto-char beginning)
  1283.         (push-mark)
  1284.         (while (re-search-forward "^@node" (point-max) t)
  1285.           (beginning-of-line)            
  1286.           (texinfo-sequentially-update-the-node))
  1287.         (message 
  1288.          "Done...updated the nodes in sequence.  You may save the buffer.")))))
  1289.  
  1290. (defun texinfo-sequentially-update-the-node ()
  1291.   "Update one node such that the pointers are sequential. 
  1292. A `Next' or `Previous' pointer points to any preceding or following node,
  1293. regardless of its hierarchical level."
  1294.  
  1295.         (texinfo-check-for-node-name)
  1296.         (texinfo-delete-existing-pointers)
  1297.         (message 
  1298.          "Sequentially updating node: %s ... " (texinfo-copy-node-name))
  1299.         (save-restriction
  1300.           (widen)
  1301.           (let*
  1302.               ((case-fold-search t)
  1303.                (level (texinfo-hierarchic-level)))
  1304.             (if (string-equal level "top")
  1305.                 (texinfo-top-pointer-case)
  1306.               ;; else
  1307.               (texinfo-sequentially-insert-pointer level 'next)
  1308.               (texinfo-sequentially-insert-pointer level 'previous)
  1309.               (texinfo-sequentially-insert-pointer level 'up)
  1310.               (texinfo-clean-up-node-line)))))
  1311.  
  1312. (defun texinfo-sequentially-find-pointer (level direction)
  1313.   "Find next or previous pointer sequentially in Texinfo file, or up pointer.
  1314. Move point to section associated with the pointer.  Find point even if
  1315. it is in a different section.
  1316.  
  1317. Return type of pointer (either 'normal or 'no-pointer).
  1318.  
  1319. The first argument is a string specifying the general kind of section
  1320. such as \"chapter\ or \"section\".  The section found will be at the
  1321. same hierarchical level in the Texinfo file, or, in the case of the up
  1322. pointer, some level higher.  The second argument (one of 'next,
  1323. 'previous, or 'up) specifies whether to find the `Next', `Previous',
  1324. or `Up' pointer."
  1325.   
  1326.   (cond ((eq direction 'next)
  1327.          (forward-line 3)             ; skip over current node
  1328.          (if (re-search-forward 
  1329.               texinfo-section-types-regexp
  1330.               (point-max)
  1331.               t)
  1332.              'normal
  1333.            'no-pointer))
  1334.         ((eq direction 'previous)
  1335.          (if (re-search-backward 
  1336.               texinfo-section-types-regexp
  1337.               (point-min)
  1338.               t)
  1339.              'normal
  1340.            'no-pointer))
  1341.         ((eq direction 'up)
  1342.          (if (re-search-backward
  1343.               (eval (cdr (assoc level texinfo-update-menu-higher-regexps)))
  1344.               beginning
  1345.               t)
  1346.              'normal
  1347.            'no-pointer))
  1348.         (t
  1349.          (error "texinfo-sequential-find-pointer: lack proper arguments"))))
  1350.  
  1351. (defun texinfo-sequentially-insert-pointer (level direction)
  1352.   "Insert the `Next', `Previous' or `Up' node name at point.
  1353. Move point forward.  
  1354.  
  1355. The first argument is the hierarchical level of the Texinfo file, a
  1356. string such as \"section\".  The second argument is direction, one of
  1357. `next, `previous, or 'up."
  1358.  
  1359.   (end-of-line)
  1360.   (insert
  1361.    ", "
  1362.    (save-excursion
  1363.      (texinfo-pointer-name
  1364.       (texinfo-sequentially-find-pointer level direction)))))
  1365.  
  1366.  
  1367. ;;; Inserting `@node' lines
  1368. ; The `texinfo-insert-node-lines' function inserts `@node' lines as needed
  1369. ; before the `@chapter', `@section', and such like lines of a region
  1370. ; in a Texinfo file.
  1371.  
  1372. (defun texinfo-insert-node-lines (beginning end &optional title-p)
  1373.   "Insert missing `@node' lines in region of Texinfo file.
  1374. Non-nil argument (prefix, if interactive) means also to insert the
  1375. section titles as node names; and also to insert the section titles as
  1376. node names in pre-existing @node lines that lack names."
  1377.   (interactive "r\nP")
  1378.  
  1379.   ;; Use marker; after inserting node lines, leave point at end of
  1380.   ;; region and mark at beginning.
  1381.  
  1382.   (let (beginning-marker end-marker title last-section-position)
  1383.  
  1384.     ;; Save current position on mark ring and set mark to end.
  1385.     (push-mark end t)                   
  1386.     (setq end-marker (mark-marker))        
  1387.  
  1388.     (goto-char beginning)
  1389.     (while (re-search-forward
  1390.             texinfo-section-types-regexp 
  1391.             end-marker
  1392.             'end)
  1393.       ;; Copy title if desired.
  1394.       (if title-p
  1395.           (progn 
  1396.             (beginning-of-line)
  1397.             (forward-word 1)
  1398.             (skip-chars-forward " \t")
  1399.             (setq title (buffer-substring
  1400.                          (point)
  1401.                          (save-excursion (end-of-line) (point))))))
  1402.       ;; Insert node line if necessary.
  1403.       (if (re-search-backward
  1404.            "^@node" 
  1405.            ;; Avoid finding previous node line if node lines are close.
  1406.            (or last-section-position    
  1407.                (save-excursion (forward-line -2) (point))) t)
  1408.           ;;  @node is present, and point at beginning of that line
  1409.           (forward-word 1)          ; Leave point just after @node.
  1410.         ;; Else @node missing; insert one.
  1411.         (beginning-of-line)         ; Beginning of `@section' line.
  1412.         (insert "@node\n")
  1413.         (backward-char 1))          ; Leave point just after `@node'.
  1414.       ;; Insert title if desired.
  1415.       (if title-p
  1416.           (progn
  1417.             (skip-chars-forward " \t")
  1418.             ;; Use regexp based on what info looks for
  1419.             ;; (alternatively, use "[a-zA-Z]+");
  1420.             ;; this means we only insert a title if none exists.
  1421.             (if (not (looking-at "[^,\t\n ]+")) 
  1422.                 (progn
  1423.                   (beginning-of-line) 
  1424.                   (forward-word 1)
  1425.                   (insert " " title)
  1426.                   (message "Inserted title %s ... " title)))))
  1427.       ;; Go forward beyond current section title.
  1428.       (re-search-forward texinfo-section-types-regexp 
  1429.                          (save-excursion (forward-line 3) (point)) t)
  1430.       (setq last-section-position (point))
  1431.       (forward-line 1))
  1432.  
  1433.     ;; Leave point at end of region, mark at beginning.
  1434.     (set-mark beginning)
  1435.  
  1436.     (if title-p
  1437.       (message
  1438.        "Done inserting node lines and titles.  You may save the buffer.")
  1439.     (message "Done inserting node lines.  You may save the buffer."))))
  1440.  
  1441.  
  1442. ;;; Update and create menus for multi-file Texinfo sources
  1443.  
  1444. ;;  1. M-x texinfo-multiple-files-update 
  1445. ;;
  1446. ;;     Read the include file list of an outer Texinfo file and
  1447. ;;     update all highest level nodes in the files listed and insert a
  1448. ;;     main menu in the outer file after its top node.
  1449.  
  1450. ;;  2. C-u M-x texinfo-multiple-files-update 
  1451. ;;
  1452. ;;     Same as 1, but insert a master menu.  (Saves reupdating lower
  1453. ;;     level menus and nodes.)  This command simply reads every menu,
  1454. ;;     so if the menus are wrong, the master menu will be wrong.
  1455. ;;     Similarly, if the lower level node pointers are wrong, they
  1456. ;;     will stay wrong.
  1457.  
  1458. ;;  3. C-u 2 M-x texinfo-multiple-files-update 
  1459. ;;
  1460. ;;     Read the include file list of an outer Texinfo file and
  1461. ;;     update all nodes and menus in the files listed and insert a
  1462. ;;     master menu in the outer file after its top node.
  1463.  
  1464. ;;; Note: these functions:
  1465. ;;;
  1466. ;;;   * Do not save or delete any buffers.  You may fill up your memory.
  1467. ;;;   * Do not handle any pre-existing nodes in outer file.  
  1468. ;;;     Hence, you may need a file for indices.
  1469.  
  1470.  
  1471. ;;; Auxiliary functions for multiple file updating
  1472.  
  1473. (defun texinfo-multi-file-included-list (outer-file)
  1474.   "Return a list of the included files in OUTER-FILE."
  1475.   (let ((included-file-list (list outer-file))
  1476.         start)
  1477.     (save-excursion
  1478.       (switch-to-buffer (find-file-noselect outer-file))
  1479.       (widen)
  1480.       (goto-char (point-min))
  1481.       (while (re-search-forward "^@include" nil t)
  1482.         (skip-chars-forward " \t")
  1483.         (setq start (point))
  1484.         (end-of-line)
  1485.         (skip-chars-backward " \t")   
  1486.         (setq included-file-list
  1487.               (cons (buffer-substring start (point))
  1488.                     included-file-list)))
  1489.       (nreverse included-file-list))))
  1490.  
  1491. (defun texinfo-copy-next-section-title ()
  1492.   "Return the name of the immediately following section as a string.
  1493.  
  1494. Start with point at the beginning of the node line.  Leave point at the
  1495. same place.  If there is no title, returns an empty string."
  1496.  
  1497.   (save-excursion
  1498.     (end-of-line)
  1499.     (let ((section-end (or 
  1500.                         (save-excursion
  1501.                           (if (re-search-forward "\\(^@node\\)" nil t)
  1502.                               (match-beginning 0)))
  1503.                         (point-max))))
  1504.       (if (re-search-forward texinfo-section-types-regexp section-end t)
  1505.           (beginning-of-line)
  1506.           ;; copy title
  1507.           (let ((title
  1508.                  (buffer-substring
  1509.                   (progn (forward-word 1)           ; skip over section type
  1510.                          (skip-chars-forward " \t") ; and over spaces
  1511.                          (point))
  1512.                   (progn (end-of-line) (point)))))
  1513.             title)
  1514.         ""))))
  1515.  
  1516. (defun texinfo-multi-file-update (files &optional update-everything)
  1517.   "Update first node pointers in each file in FILES.
  1518. Return a list of the node names and the title immediate following them.
  1519.  
  1520. The first file in the list is an outer file; the remaining are
  1521. files included in the outer file with `@include' commands.
  1522.  
  1523. If optional arg UPDATE-EVERYTHING non-nil, update every menu and
  1524. pointer in each of the included files.
  1525.  
  1526. Also update the `Top' level node pointers of the outer file.
  1527.  
  1528. Requirements:
  1529.  
  1530.   * the first file in the FILES list must be the outer file,
  1531.   * each of the included files must contain exactly one highest
  1532.     hierarchical level node, 
  1533.   * this node must be the first node in the included file,
  1534.   * each highest hierarchical level node must be of the same type.
  1535.  
  1536. Thus, normally, each included file contains one, and only one,
  1537. chapter.
  1538.  
  1539. The menu-list has the form:
  1540.  
  1541.     \(\(\"node-name1\" . \"title1\"\) 
  1542.       \(\"node-name2\" . \"title2\"\) ... \)
  1543.  
  1544. However, there does not need to be a title field."
  1545.   
  1546.   (let (menu-list)
  1547.     
  1548.     ;; Find the name of the first node of the first included file.
  1549.     (switch-to-buffer (find-file-noselect (car (cdr files))))
  1550.     (widen)
  1551.     (goto-char (point-min))
  1552.     (if (not (re-search-forward "^@node" nil t))
  1553.         (error "No `@node' line found in %s !" (buffer-name)))
  1554.     (beginning-of-line)
  1555.     (texinfo-check-for-node-name)
  1556.     (setq next-node-name (texinfo-copy-node-name))
  1557.     
  1558.     (setq menu-list
  1559.           (cons (cons 
  1560.                  next-node-name
  1561.                  (texinfo-copy-next-section-title))
  1562.                 menu-list))
  1563.     
  1564.     ;; Go to outer file
  1565.     (switch-to-buffer (find-file-noselect (car files)))
  1566.     (goto-char (point-min))
  1567.     (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t))
  1568.         (error "This buffer needs a Top node!"))
  1569.     (beginning-of-line)
  1570.     (texinfo-delete-existing-pointers)
  1571.     (end-of-line)
  1572.     (insert ", " next-node-name ", (dir), (dir)")
  1573.     (beginning-of-line)
  1574.     (setq previous-node-name "Top")
  1575.     (setq files (cdr files))
  1576.     
  1577.     (while files
  1578.       
  1579.       (if (not (cdr files))
  1580.           ;; No next file
  1581.           (setq next-node-name "")
  1582.         ;; Else,
  1583.         ;; find the name of the first node in the next file.
  1584.         (switch-to-buffer (find-file-noselect (car (cdr files))))
  1585.         (widen)
  1586.         (goto-char (point-min))
  1587.         (if (not (re-search-forward "^@node" nil t))
  1588.             (error "No `@node' line found in %s !" (buffer-name)))
  1589.         (beginning-of-line)
  1590.         (texinfo-check-for-node-name)
  1591.         (setq next-node-name (texinfo-copy-node-name))
  1592.         (setq menu-list
  1593.               (cons (cons 
  1594.                      next-node-name
  1595.                      (texinfo-copy-next-section-title))
  1596.                     menu-list)))
  1597.  
  1598.       ;; Go to node to be updated.
  1599.       (switch-to-buffer (find-file-noselect (car files)))
  1600.       (goto-char (point-min))
  1601.       (if (not (re-search-forward "^@node" nil t))
  1602.           (error "No `@node' line found in %s !" (buffer-name)))
  1603.       (beginning-of-line)
  1604.       (texinfo-delete-existing-pointers)
  1605.       (end-of-line)
  1606.       (insert ", " next-node-name ", " previous-node-name ", " up-node-name)
  1607.       
  1608.       (beginning-of-line)
  1609.       (setq previous-node-name (texinfo-copy-node-name))
  1610.       
  1611.       ;; Update other menus and nodes if requested.
  1612.       (if update-everything (texinfo-all-menus-update t))
  1613.       
  1614.       (setq files (cdr files)))
  1615.     (nreverse menu-list)))
  1616.  
  1617. (defun texinfo-multi-files-insert-main-menu (menu-list)
  1618.   "Insert formatted main menu at point.
  1619. Indents the first line of the description, if any, to the value of
  1620. texinfo-column-for-description."
  1621.  
  1622.   (insert "@menu\n")
  1623.   (while menu-list
  1624.     (if (cdr (car menu-list))       ; menu-list has description entry
  1625.         (progn
  1626.           (insert 
  1627.            (format "* %s::" (car (car menu-list)))) ; node-name entry
  1628.           (indent-to texinfo-column-for-description 2)
  1629.           (insert 
  1630.            (format "%s\n" (cdr (car menu-list)))))  ; description entry
  1631.         ;; else menu-list lacks description entry
  1632.       (insert
  1633.        (format "* %s::\n" (car (car menu-list)))))  ; node-name entry
  1634.     (setq menu-list (cdr menu-list)))
  1635.   (insert "@end menu"))
  1636.  
  1637.  
  1638. (defun texinfo-multi-file-master-menu-list (files-list)
  1639.   "Return master menu list from files in FILES-LIST.
  1640. Menu entries in each file collected using `texinfo-master-menu-list'.
  1641.  
  1642. The first file in FILES-LIST must be the outer file; the others must
  1643. be the files included within it.  A main menu must already exist."
  1644.   (save-excursion
  1645.     (let (master-menu-list)
  1646.       (while files-list
  1647.         (switch-to-buffer (find-file-noselect (car files-list)))
  1648.         (message "Working on: %s " (current-buffer))
  1649.         (goto-char (point-min))
  1650.         (setq master-menu-list
  1651.               (append master-menu-list (texinfo-master-menu-list)))
  1652.         (setq files-list (cdr files-list)))
  1653.       master-menu-list)))
  1654.  
  1655.  
  1656. ;;; The multiple-file update function
  1657.  
  1658. (defun texinfo-multiple-files-update
  1659.   (outer-file &optional update-everything make-master-menu)
  1660.   "Update first node pointers in each file included in OUTER-FILE;
  1661. create or update main menu in the outer file that refers to such nodes. 
  1662. This does not create or update menus or pointers within the included files.
  1663.  
  1664. With optional MAKE-MASTER-MENU argument (prefix arg, if interactive),
  1665. insert a master menu in OUTER-FILE.  This does not create or update
  1666. menus or pointers within the included files.
  1667.  
  1668. With optional UPDATE-EVERYTHING argument (numeric prefix arg, if
  1669. interactive), update all the menus and all the `Next', `Previous', and
  1670. `Up' pointers of all the files included in OUTER-FILE before inserting
  1671. a master menu in OUTER-FILE.
  1672.  
  1673. The command also updates the `Top' level node pointers of OUTER-FILE.
  1674.  
  1675. Notes: 
  1676.  
  1677.   * this command does NOT save any files--you must save the
  1678.     outer file and any modified, included files.
  1679.  
  1680.   * except for the `Top' node, this command does NOT handle any
  1681.     pre-existing nodes in the outer file; hence, indices must be
  1682.     enclosed in an included file.
  1683.  
  1684. Requirements:
  1685.  
  1686.   * each of the included files must contain exactly one highest
  1687.     hierarchical level node, 
  1688.   * this highest node must be the first node in the included file,
  1689.   * each highest hierarchical level node must be of the same type.
  1690.  
  1691. Thus, normally, each included file contains one, and only one,
  1692. chapter."
  1693.  
  1694.   (interactive "fName of outer `include' file: ")
  1695.  
  1696.   (cond (current-prefix-arg
  1697.          (setq make-master-menu (listp current-prefix-arg))
  1698.          (setq update-everything (numberp current-prefix-arg))))
  1699.  
  1700.   (let* ((included-file-list (texinfo-multi-file-included-list outer-file))
  1701.          (files included-file-list)
  1702.          main-menu-list
  1703.          next-node-name
  1704.          previous-node-name
  1705.          (up-node-name "Top"))
  1706.  
  1707. ;;; Update the pointers 
  1708. ;;; and collect the names of the nodes and titles
  1709.     (setq main-menu-list (texinfo-multi-file-update files update-everything))
  1710.  
  1711. ;;; Insert main menu
  1712.  
  1713.   ;; Go to outer file
  1714.   (switch-to-buffer (find-file-noselect (car included-file-list)))
  1715.   (if (texinfo-old-menu-p
  1716.        (point-min)
  1717.        (save-excursion
  1718.          (re-search-forward "^@include")
  1719.          (beginning-of-line)
  1720.          (point)))
  1721.  
  1722.       ;; If found, leave point after word `menu' on the `@menu' line.
  1723.       (progn
  1724.         (texinfo-incorporate-descriptions main-menu-list)
  1725.         ;; Delete existing menu.
  1726.         (beginning-of-line)
  1727.         (delete-region
  1728.          (point)
  1729.          (save-excursion (re-search-forward "^@end menu") (point)))
  1730.         ;; Insert main menu
  1731.         (texinfo-multi-files-insert-main-menu main-menu-list))
  1732.  
  1733.     ;; Else no current menu; insert it before `@include'
  1734.     (texinfo-multi-files-insert-main-menu main-menu-list))
  1735.  
  1736. ;;; Insert master menu
  1737.  
  1738.   (if make-master-menu
  1739.       (progn
  1740.         ;; First, removing detailed part of any pre-existing master menu
  1741.         (goto-char (point-min))
  1742.         (if (re-search-forward texinfo-master-menu-header nil t)
  1743.             ;; Remove detailed master menu listing
  1744.             (progn
  1745.               (goto-char (match-beginning 0))
  1746.               (let ((end-of-detailed-menu-descriptions
  1747.                      (save-excursion     ; beginning of end menu line
  1748.                        (goto-char (texinfo-menu-end))
  1749.                        (beginning-of-line) (forward-char -1)
  1750.                        (point))))
  1751.                 (delete-region (point) end-of-detailed-menu-descriptions))))
  1752.  
  1753.         ;; Create a master menu and insert it
  1754.         (texinfo-insert-master-menu-list 
  1755.          (texinfo-multi-file-master-menu-list 
  1756.           included-file-list)))))
  1757.   (message "Multiple files updated."))
  1758.  
  1759.  
  1760. ;;; Place `provide' at end of file.
  1761. (provide 'texnfo-upd)
  1762. ;;;;;;;;;;;;;;;; end texnfo-upd.el ;;;;;;;;;;;;;;;;
  1763.